/*
 * Copyright (C) 2016 Square, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.squareup.leakcanary;

import java.io.File;

/**
 * Provides the directory in which heap dumps and analysis results will be stored.
 * When using your own implementation, you may also want to call {@link
 * LeakCanary#setDisplayLeakActivityDirectoryProvider(LeakDirectoryProvider)}.
 */
public interface LeakDirectoryProvider {

  /** Returns a path to an existing directory were leaks can be stored. */
  File leakDirectory();

  void requestWritePermission();

  /** True if we can currently write to the leak directory. */
  boolean isLeakStorageWritable();
}
